MongoDB Atlas Administration API (2.0)

Download OpenAPI specification:Download

The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas. To learn more, review the Administration API overview. This OpenAPI specification covers all of the collections with the exception of Alerts, Alert Configurations, and Events. Refer to the legacy documentation for the specifications of these resources.

Access Tracking

Returns access logs for authentication attempts made to MongoDB Cloud database deployments.

Alert Configurations

Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.

Alerts

Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.

Auditing

Returns and edits database auditing settings for MongoDB Cloud projects.

Return the Auditing Configuration for One Project

Returns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "configurationType": "FILTER_BUILDER",
  • "enabled": false
}

Update Auditing Configuration for One Project

Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updated auditing configuration for the specified project.

auditAuthorizationSuccess
required
boolean
Default: false

Flag that indicates whether someone set auditing to track successful authentications. This only applies to the "atype" : "authCheck" audit filter. Setting this parameter to true degrades cluster performance.

auditFilter
required
string

JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (\).

enabled
required
boolean
Default: false

Flag that indicates whether someone enabled database auditing for the specified project.

Responses

Request samples

Content type
application/json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "enabled": false
}

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "configurationType": "FILTER_BUILDER",
  • "enabled": false
}

Cloud Backups

Returns, takes, edits, and removes Cloud Backup snapshots.

Cloud Backup Export

Returns, adds, and removes Cloud Backup snapshot export buckets. Also returns and adds Cloud Backup export jobs.

Cloud Backup Restore Jobs

Returns, starts, and cancels Cloud Backup restore jobs.

Cloud Backup Schedule

Returns, edits, and removes Cloud Backup schedules.

Cloud Migration Service

Manages the Cloud Migration Service.

Cloud Provider Access

Returns, adds, authorizes, and removes AWS IAM roles in Atlas.

Clusters

Returns, adds, edits, and removes database deployments.

Custom DNS for Atlas Clusters Deployed to AWS

Returns and edits custom DNS configurations for Atlas database deployments on AWS.

Custom Database Roles

Returns, adds, edits, and removes custom database user privilege roles.

Database Users

Returns, adds, edits, and removes database users.

Data Federation

Returns, adds, edits, and removes Federated Database Instances.

Data Federation Private Networks

Returns, adds, and removes all private endpoints for Federated Database Instances and Online Archives in the specified project.

Data Lake Pipelines

Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.

Encryption at Rest using Customer Key Management

Returns and edits the Encryption at Rest using Customer Key Management configuration.

Events

Returns events. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.

Federated Authentication

Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.

Global Clusters

Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings.

Invoices

Returns invoices.

LDAP Configuration

Returns, edits, verifies, and removes LDAP configurations.

Legacy Backup Snapshots

Returns, removes, and edits the expiration date of Legacy Backup snapshots.

Legacy Backup Restore Jobs

Returns and adds restore jobs for database deployments that use Legacy Backups.

Legacy Backup Checkpoints

Returns Legacy Backup Checkpoint metadata. Checkpoints serve as additional restore points for sharded clusters at points in time between regular snapshots.

Legacy Backup Snapshot Schedule

Returns and edits Legacy Backup snapshot schedules.

Maintenance Windows

Returns, edits, and removes maintenance windows.

MongoDB Cloud Users

Returns, adds, and edits MongoDB Cloud users.

Monitoring and Logs

Returns database deployment monitoring and logging data.

Multi-Cloud Clusters

Returns, adds, edits, or removes multi-cloud clusters.

Network Peering

Returns, adds, edits, and removes network peering containers and peering connections.

Network Peering Connections

Returns, adds, edits, and removes network peering connections.

Network Peering Containers

Returns, adds, edits, and removes network peering containers.

Online Archive

Returns, adds, edits, or removes an online archive.

Organizations

Returns, adds, and edits organizational units in MongoDB Cloud.

Performance Advisor

Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds.

Private Endpoint Services

Returns, adds, edits, and removes private endpoint services.

Programmatic API Keys

Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.

Return All Organization API Keys Assigned to One Project

Returns all organization API keys that you assigned to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.

pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Create and Assign One Organization API Key to One Project

Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Organization API key to be created and assigned to the specified project. This request requires a minimum of one of the two body parameters.

desc
string [ 1 .. 250 ] characters

Purpose or explanation provided when someone created this organization API key.

roles
Array of strings
Items Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project.

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Unassign One Organization API Key from One Project

Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Update Roles of One Organization API Key to One Project

Updates the roles of the organization API key that you specify for the project that you specify. You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.

query Parameters
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Organization API Key to be updated. This request requires a minimum of one of the two body parameters.

desc
string [ 1 .. 250 ] characters

Purpose or explanation provided when someone created this organization API key.

roles
Array of strings
Items Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project.

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Assign One Organization API Key to One Project

Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Organization API key to be assigned to the specified project.

Array
roles
Array of strings
Items Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_OWNER" "GROUP_READ_ONLY"

List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Return All Organization API Keys

Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.

pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Create One Organization API Key

Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Organization API Key to be created. This request requires a minimum of one of the two body parameters.

desc
string [ 1 .. 250 ] characters

Purpose or explanation provided when someone created this organization API key.

roles
Array of strings
Items Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project.

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Remove One Organization API Key

Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

Return One Organization API Key

Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Update One Organization API Key

Updates one organization API key in the specified organization. The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key you want to update.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Organization API key to be updated. This request requires a minimum of one of the two body parameters.

desc
string [ 1 .. 250 ] characters

Purpose or explanation provided when someone created this organization API key.

Array of objects (Role Assignment)

List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Return All Access List Entries for One Organization API Key

Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.

pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Create Access List Entries for One Organization API Key

Creates the access list entries for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role and an entry for the project access list.

Authorizations:
DigestAuth
path Parameters
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.

pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Access list entries to be created for the specified organization API key.

Array
cidrBlock
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|([\:]{0,2}([0...

Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or ipAddress but not both in the same request.

ipAddress
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|([\:]{0,2}([0...

Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or cidrBlock but not both in the same request.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Remove One Access List Entry for One Organization API Key

Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role and an entry for the project access list.

Authorizations:
DigestAuth
path Parameters
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.

ipAddress
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example: 192.0.2.0%2F24

One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Access List Entry for One Organization API Key

Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

ipAddress
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example: 192.0.2.0%2F24

One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Project IP Access List

Returns, adds, edits, and removes network access limits to database deployments in MongoDB Cloud.

Projects

Returns, adds, and edits collections of clusters and users in MongoDB Cloud.

Return All Projects

Returns details about all projects. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Read Write role. This resource doesn't require the API Key to have an Access List.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.

pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Create One Project

Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Read Write role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

projectOwnerId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

Request Body schema: application/json

Creates one project.

name
required
string [ 1 .. 64 ] characters ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

Human-readable label that identifies the project included in the MongoDB Cloud organization.

orgId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.

withDefaultAlertsSettings
boolean

Flag that indicates whether to create the project with default alert settings.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "orgId": "4888442a3354817a7320eb61",
  • "withDefaultAlertsSettings": true
}

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Return One Project using Its Name

Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupName
required
string [ 1 .. 64 ] characters

Human-readable label that identifies this project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Remove One Project

Removes the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Project

Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Return All Project Invitations

Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

username
string <email> ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...

Email address of the user account invited to this project.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
[ ]

Update One Project Invitation

Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updates the details of one pending invitation to the specified project.

roles
Array of strings unique
Items Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

One or more organization or project level roles to assign to the MongoDB Cloud user.

username
string <email> ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...

Email address of the MongoDB Cloud user invited to the specified project.

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Invite One MongoDB Cloud User to Join One Project

Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json

Invites one MongoDB Cloud user to join the specified project.

roles
Array of strings unique
Items Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

One or more organization or project level roles to assign to the MongoDB Cloud user.

username
string <email> ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...

Email address of the MongoDB Cloud user invited to the specified project.

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Cancel One Project Invitation

Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

invitationId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the invitation.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

Return One Project Invitation

Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

invitationId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the invitation.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Update One Project Invitation by Invitation ID

Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

invitationId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the invitation.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json

Updates the details of one pending invitation to the specified project.

roles
Array of strings unique
Items Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

One or more organization or project level roles to assign to the MongoDB Cloud user.

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ]
}

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Return All Limits for One Project

Returns all the limits for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
Example
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "maximumLimit": 0,
  • "name": "atlas.project.deployment.clusters",
  • "value": 0
}

Remove One Project Limit

Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
limitName
required
string
Enum: "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion"

Human-readable label that identifies this project limit.

Limit Name Description Default
atlas.project.deployment.clusters Limit on the number of clusters in this project 25
atlas.project.deployment.nodesPerPrivateLinkRegion Limit on the number of nodes per Private Link region in this project 50
atlas.project.security.databaseAccess.customRoles Limit on the number of custom roles in this project 100
atlas.project.security.databaseAccess.users Limit on the number of database users in this project 100
atlas.project.security.networkAccess.crossRegionEntries Limit on the number of cross-region network access entries in this project 40
atlas.project.security.networkAccess.entries Limit on the number of network access entries in this project 200
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Limit for One Project

Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
limitName
required
string
Enum: "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion"

Human-readable label that identifies this project limit.

Limit Name Description Default
atlas.project.deployment.clusters Limit on the number of clusters in this project 25
atlas.project.deployment.nodesPerPrivateLinkRegion Limit on the number of nodes per Private Link region in this project 50
atlas.project.security.databaseAccess.customRoles Limit on the number of custom roles in this project 100
atlas.project.security.databaseAccess.users Limit on the number of database users in this project 100
atlas.project.security.networkAccess.crossRegionEntries Limit on the number of cross-region network access entries in this project 40
atlas.project.security.networkAccess.entries Limit on the number of network access entries in this project 200
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
Example
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "maximumLimit": 0,
  • "name": "atlas.project.deployment.clusters",
  • "value": 0
}

Set One Project Limit

Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
limitName
required
string
Enum: "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion"

Human-readable label that identifies this project limit.

Limit Name Description Default
atlas.project.deployment.clusters Limit on the number of clusters in this project 25
atlas.project.deployment.nodesPerPrivateLinkRegion Limit on the number of nodes per Private Link region in this project 50
atlas.project.security.databaseAccess.customRoles Limit on the number of custom roles in this project 100
atlas.project.security.databaseAccess.users Limit on the number of database users in this project 100
atlas.project.security.networkAccess.crossRegionEntries Limit on the number of cross-region network access entries in this project 40
atlas.project.security.networkAccess.entries Limit on the number of network access entries in this project 200
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json
value
required
integer <int64>

Amount to set the limit to.

Responses

Request samples

Content type
application/json
Example
{
  • "value": 0,
  • "name": "atlas.project.deployment.clusters"
}

Response samples

Content type
application/vnd.atlas.2023-01-01+json
Example
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "maximumLimit": 0,
  • "name": "atlas.project.deployment.clusters",
  • "value": 0
}

Return One Project Settings

Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. This resource does not require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isExtendedStorageSizesEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

Update One Project Settings

Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role. This resource does not require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json
isCollectDatabaseSpecificsStatisticsEnabled
boolean

Flag that indicates whether to collect database-specific metrics for the specified project.

isDataExplorerEnabled
boolean

Flag that indicates whether to enable the Data Explorer for the specified project.

isExtendedStorageSizesEnabled
boolean

Flag that indicates whether to enable extended storage sizes for the specified project.

isPerformanceAdvisorEnabled
boolean

Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project.

isRealtimePerformancePanelEnabled
boolean

Flag that indicates whether to enable the Real Time Performance Panel for the specified project.

isSchemaAdvisorEnabled
boolean

Flag that indicates whether to enable the Schema Advisor for the specified project.

Responses

Request samples

Content type
application/json
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isExtendedStorageSizesEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isExtendedStorageSizesEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

Return All Users in One Project

Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.

pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

flattenTeams
boolean
Default: false

Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If "flattenTeams" : false, this resource returns only users with a role in the project. If "flattenTeams" : true, this resource returns both users with roles in the project and users who belong to teams with roles in the project.

includeOrgUsers
boolean
Default: false

Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If "includeOrgUsers": false, this resource returns only users with a role in the project. If "includeOrgUsers": true, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Remove One User from One Project

Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

userId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Rolling Index

Creates one index to a database deployment in a rolling manner.

Root

Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.

Serverless Instances

Returns, adds, edits, and removes serverless instances.

Serverless Private Endpoints

Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.

Shared-Tier Restore Jobs

Returns and adds restore jobs for shared-tier database deployments.

Shared-Tier Snapshots

Returns and requests to download shared-tier database deployment snapshots.

Teams

Returns, adds, edits, or removes teams.

Return All Teams in One Project

Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.

pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

Responses

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Add One or More Teams to One Project

Adds one team to the specified project. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Team to add to the specified project.

roleNames
Array of strings unique
Items Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

One or more organization- or project-level roles to assign to the MongoDB Cloud user.

teamId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal character string that identifies the team.

Responses

Request samples

Content type
application/json
{
  • "roleNames": [
    ],
  • "teamId": "e254e4ade2206f4520d4107d"
}

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Remove One Team from One Project

Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project User Admin role.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

teamId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Update Team Roles in One Project

Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project User Admin role.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

teamId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

The project roles assigned to the specified team.

roleNames
Array of strings unique
Items Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

One or more organization- or project-level roles to assign to the MongoDB Cloud user.

teamId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal character string that identifies the team.

Responses

Request samples

Content type
application/json
{
  • "roleNames": [
    ],
  • "teamId": "e254e4ade2206f4520d4107d"
}

Response samples

Content type
application/vnd.atlas.2023-01-01+json
{ }

Test

Atlas test endpoints.

Example resource info for versioning of the Atlas API

Returns some text dummy data for test purposes.

Authorizations:
DigestAuth
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
{ }

Third-Party Service Integrations

Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.

Return All Active Third-Party Service Integrations

Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.

pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Remove One Third-Party Service Integration

Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
integrationType
required
string
Enum: "PAGER_DUTY" "MICROSOFT_TEAMS" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "PROMETHEUS"

Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.

groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Third-Party Service Integration

Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

integrationType
required
string
Enum: "PAGER_DUTY" "MICROSOFT_TEAMS" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "PROMETHEUS"

Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Configure One Third-Party Service Integration

Adds the settings for configuring one third-party service integration. These settings apply to all databases managed in the specified MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
integrationType
required
string
Enum: "PAGER_DUTY" "MICROSOFT_TEAMS" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "PROMETHEUS"

Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.

groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.

pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Update One Third-Party Service Integration

Updates the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.

Authorizations:
DigestAuth
path Parameters
integrationType
required
string
Enum: "PAGER_DUTY" "MICROSOFT_TEAMS" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "PROMETHEUS"

Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.

groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.

pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

X.509 Authentication for Database Users

Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.